package com.thoughtservice.jspdoc.customize;

import com.thoughtservice.jspdoc.*;


/**
 * <p>Interface that developers can implement to enhance the output of their JSP documentation for
 * their specific site.  Implement this interface and pass the full name of your implementation
 * on the command line to the <code>DirTree.main()</code> method.  The JSP Documentation generator
 * will then call the methods on your implementation at certain point during the production of the
 * JSP Documentation so that you can customize the output for your needs.</p>
 * 
 * <p>Currently the following customization is possible:
 * <ul>
 *  <li>Extra information about parameters (<code>customizeParams(...)</code> method).  This allows 
 *      you to specify extra information about each parameter that is found in the page.  We use this 
 *      to pull information out of our validation database which is a repository of validation rules
 *      that we run on every request to a page.  You could use this for something similar or something
 *      different.</li>
 * </ul>
 * </p>
 * 
 * @author alex
 */
public interface Customizer {


public String customizeParam(JSPPage page, String name, String type, String source, String desc);

public boolean customizeParams();

}
